My Blog
← Back to home

GSD (Get Shit Done) 使用教程

GSD (Get Shit Done) 使用教程

GSD 是一套面向 Claude Code 的 spec-driven 开发系统。核心理念：把 AI 编程从随意对话变成有纪律的工程流程。

安装与更新

# 安装（全局）
npx get-shit-done-cc@latest --claude --global
 
# 更新到最新版
npx get-shit-done-cc@latest
 
# 在 Claude Code 中更新（会显示 changelog）
/gsd-update
 
# 卸载
npx get-shit-done-cc --uninstall

安装后，~/.claude/skills/ 下会出现 65 个 gsd-* 技能，~/.claude/agents/ 下会出现 33 个 GSD 子 agent。

核心概念

三层结构

Project（项目）
  └── Milestone（里程碑，如 v1.0、v2.0）
        └── Phase（阶段，如 01-基础框架、02-核心功能）
              └── Plan（执行计划，每个 Phase 可有多个 Plan）

关键目录

所有规划文件都在项目根目录的 .planning/ 下：

.planning/
├── PROJECT.md          # 项目愿景和需求
├── ROADMAP.md          # 阶段划分和状态
├── STATE.md            # 项目记忆（跨会话保持上下文）
├── config.json         # 工作流模式配置
├── REQUIREMENTS.md     # 带优先级的需求清单
├── phases/             # 各阶段的计划和执行结果
│   └── 01-foundation/
│       ├── 01-01-PLAN.md
│       └── 01-01-SUMMARY.md
├── spikes/             # 可行性实验
├── sketches/           # UI 设计草图
├── todos/              # 待办事项
└── debug/              # 调试记录

两种工作模式

模式 特点 适合场景
Interactive 每步确认，手动审批 新项目、复杂决策
YOLO 自动审批，快速推进 明确需求、快速迭代

基础用法

1. 创建新项目

在一个空目录中开始：

/gsd-new-project

GSD 会依次引导你完成：

  1. 深度提问 — 理解你要构建什么
  2. 领域研究（可选）— 启动 4 个并行研究员 agent 调研技术栈
  3. 需求定义 — 按 v1/v2/out-of-scope 分级
  4. 路线图生成 — 自动拆分为带编号的阶段

完成后你会得到 PROJECT.md、REQUIREMENTS.md、ROADMAP.md、STATE.md。

例子：开发一个笔记应用

/gsd-new-project

对话中描述："我想做一个 Markdown 笔记应用，支持双向链接、标签、全文搜索，数据存 SQLite。"

GSD 会生成类似这样的路线图：

  • Phase 1: 基础架构（Next.js + SQLite 搭建）
  • Phase 2: 核心编辑器（Markdown 编辑 + 预览）
  • Phase 3: 双向链接（[[链接]] 语法 + 反向引用）
  • Phase 4: 搜索与标签（全文索引 + 标签管理）

2. 规划阶段

对第一个阶段生成详细执行计划：

/gsd-plan-phase 1

GSD 会：

  • 分析 Phase 1 的需求范围
  • 研究技术方案（如果需要）
  • 生成具体的 01-01-PLAN.md，包含可执行的任务步骤

如果你想先讨论 Phase 的方向再规划：

/gsd-discuss-phase 2

这会创建 CONTEXT.md，记录你对这个阶段的想法和边界。

3. 执行阶段

/gsd-execute-phase 1

GSD 会：

  • 按 wave 分组并行执行计划
  • 每个 plan 由独立的 gsd-executor agent 执行
  • 执行完自动生成 SUMMARY.md
  • 更新 STATE.md 和 REQUIREMENTS.md

推荐的工作节奏（防止上下文溢出）：

/gsd-plan-phase 1     # 规划
/clear                 # 清理上下文
/gsd-execute-phase 1   # 执行
/clear                 # 清理上下文
/gsd-progress          # 查看进度，继续下一步

4. 查看进度

/gsd-progress

输出类似：

Project: note-app
Milestone: v1.0 (3/5 phases complete)
████████████████░░░░░░░░ 60%

Phase 1: Foundation     ✅ COMPLETE
Phase 2: Core Editor    ✅ COMPLETE
Phase 3: Bidirectional  ✅ COMPLETE
Phase 4: Search & Tags  🔄 READY (plan needed)
Phase 5: Polish & Ship  ⏳ PENDING

Next: /gsd-plan-phase 4

5. 恢复工作

重新打开 Claude Code 后：

/gsd-resume-work

自动读取 STATE.md 恢复上下文，告诉你上次做到哪了、下一步该做什么。

进阶用法

快速任务（不做完整规划）

对于小改动，不需要走完整的 Phase 流程：

极简模式（3 行以内改动，无子 agent）：

/gsd-fast "fix the typo in README"
/gsd-fast "add .env to gitignore"

快速模式（小功能，有计划有提交）：

/gsd-quick

然后在交互中描述任务。GSD 会生成计划、执行、提交，但跳过研究员和验证 agent。

带质量保证的快速任务：

/gsd-quick --full

--full 启用完整质量管线：讨论 + 研究 + 计划检查 + 验证。也可以单独启用：

/gsd-quick --validate              # 只启用计划检查 + 验证
/gsd-quick --discuss               # 先讨论再规划
/gsd-quick --research --validate   # 研究 + 验证（组合使用）

可行性验证（Spike）

不确定某个技术方案行不行？用 spike 快速验证：

/gsd-spike "can we stream LLM output over WebSockets?"

GSD 会：

  1. 把问题拆成 2-5 个聚焦实验
  2. 每个实验有明确的 Given/When/Then 验证条件
  3. 写最小代码跑实验
  4. 给出 VALIDATED / INVALIDATED / PARTIAL 结论
  5. 结果存到 .planning/spikes/

快速验证（跳过拆解，直接动手）：

/gsd-spike --quick "test if pdfjs extracts tables"

验收 spike 成果：

/gsd-spike-wrap-up

把验证过的发现整理成项目技能，后续规划时可以引用。

UI 设计探索（Sketch）

/gsd-sketch "dashboard layout for the admin panel"

GSD 会：

  1. 先和你聊设计方向和风格
  2. 生成 2-3 个 HTML 变体（不同布局/配色方案）
  3. 你选择喜欢的元素，迭代优化
  4. CSS 主题系统跨 sketch 复用
/gsd-sketch-wrap-up    # 整理设计决策为项目技能

智能路由

不确定该用哪个命令？

/gsd-do fix the login button
/gsd-do refactor the auth system
/gsd-do I want to start a new milestone

GSD 自动分析你的意图，路由到正确的命令。

调试

/gsd-debug "form submission fails silently"

系统化的调试流程：

  1. 收集症状
  2. 提出假设
  3. 验证/推翻假设
  4. 定位根因
  5. 修复

跨会话恢复调试：

/clear           # 上下文满了
/gsd-debug       # 自动恢复上次调试状态

调试记录存在 .planning/debug/，不会因为清上下文丢失。

阶段微调

插入紧急阶段：

/gsd-insert-phase 5 "Critical security fix"

在 Phase 5 和 Phase 6 之间插入 Phase 5.1。

追加新阶段：

/gsd-add-phase "Add admin dashboard"

删除不需要的阶段：

/gsd-remove-phase 17

里程碑管理

开始新里程碑：

/gsd-new-milestone "v2.0 Features"

类似 /gsd-new-project 的流程，但保留现有项目结构。

完成里程碑：

/gsd-complete-milestone 1.0.0

自动归档、创建 git tag、准备下一版本。

审计里程碑：

/gsd-audit-milestone        # 检查是否所有需求都完成了
/gsd-plan-milestone-gaps    # 为遗漏的需求生成新阶段

发布代码

创建 PR：

/gsd-ship 4            # 为 Phase 4 创建 PR
/gsd-ship 4 --draft    # 创建草稿 PR

清理 PR 分支（过滤掉 .planning/ 提交）：

/gsd-pr-branch main

审查者只看到代码变更，不会看到 GSD 的规划文件。

跨 AI 审查

/gsd-review --phase 3 --all

调用外部 AI CLI（Gemini、Codex 等）独立审查你的计划，生成 REVIEWS.md。

配置

/gsd-settings           # 交互式配置
/gsd-set-profile budget # 切换模型策略

模型策略选项：

策略 规划 执行 验证 成本
quality Opus Opus Sonnet 高
balanced Opus Sonnet Sonnet 中（默认）
budget Sonnet Sonnet Haiku 低
inherit 当前模型 当前模型 当前模型 跟随会话

现有项目接入

已有代码库想用 GSD 管理：

/gsd-map-codebase       # 分析现有代码结构
/gsd-new-project        # 基于分析结果建立规划

gsd-map-codebase 会启动多个 Explore agent 并行分析，生成 7 份文档（技术栈、架构、目录结构、编码规范、测试、集成、问题点）。

常用工作流总结

新项目从零开始

/gsd-new-project              # 提问 → 研究 → 需求 → 路线图
/gsd-plan-phase 1             # 规划第一阶段
/gsd-execute-phase 1          # 执行
/gsd-progress                 # 查看进度，继续下一阶段

小任务快速完成

/gsd-fast "fix typo"          # 极简
/gsd-quick                     # 小功能
/gsd-quick --full              # 小功能 + 完整质量保证

技术验证

/gsd-spike "can we use X?"    # 快速实验
/gsd-spike-wrap-up            # 整理结论

调试问题

/gsd-debug "bug描述"          # 开始调试
/clear                         # 上下文满了
/gsd-debug                     # 恢复调试

完整里程碑周期

/gsd-new-project
# ... 多轮 plan → execute ...
/gsd-complete-milestone 1.0.0
/gsd-new-milestone "v2.0"

暂停和恢复

/gsd-pause-work               # 保存当前状态
# ... 关掉电脑 ...
/gsd-resume-work              # 恢复上下文继续

注意事项

  1. 定期 /clear：GSD 的规划上下文可能很大，执行完一个 Phase 后清理上下文，用 /gsd-resume-work 恢复。
  2. 先 map 再 new：对于已有项目，先 /gsd-map-codebase 再 /gsd-new-project，规划质量会好很多。
  3. /gsd-progress 是你的朋友：不确定做到哪了？随时跑一下。
  4. spike 不走完整流程：spike 是轻量实验，不要求先 /gsd-new-project，任何仓库都能直接用。
  5. 规划文件默认提交 git：如果不想提交，设置 .planning/config.json 中 commit_docs: false。
  6. 更新频率：GSD 更新很快，定期 /gsd-update 检查新版本。